docs: add TS to envconfig #3996
Open
+943
−374
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
📖 Docs PR preview links
|
THardy98
reviewed
Nov 14, 2025
Comment on lines
351
to
365
| // The 'staging' profile in config.toml has an incorrect address (localhost:9999) | ||
| // We'll programmatically override it to the correct address | ||
|
|
||
| // Load the 'staging' profile. | ||
| const config = loadClientConnectConfig({ | ||
| profile: profileName, | ||
| configSource: { path: configFile }, | ||
| }); | ||
|
|
||
| // Override the target host to the correct address. | ||
| // This is the recommended way to override configuration values. | ||
| config.connectionOptions.address = 'localhost:7233'; | ||
|
|
||
| console.log(`\nLoaded '${profileName}' profile from ${configFile} with overrides.`); | ||
| console.log(` Address: ${config.connectionOptions.address} (overridden from localhost:9999)`); |
Contributor
There was a problem hiding this comment.
I don't think we need to do this override bit, I would follow the simpler sample here, imo.
Comment on lines
642
to
658
| console.log("--- Loading 'staging' profile with programmatic overrides ---"); | ||
|
|
||
| const configFile = resolve(__dirname, '../config.toml'); | ||
| const profileName = 'staging'; | ||
|
|
||
| // The 'staging' profile in config.toml has an incorrect address (localhost:9999) | ||
| // We'll programmatically override it to the correct address | ||
|
|
||
| // Load the 'staging' profile. | ||
| const config = loadClientConnectConfig({ | ||
| profile: profileName, | ||
| configSource: { path: configFile }, | ||
| }); | ||
|
|
||
| // Override the target host to the correct address. | ||
| // This is the recommended way to override configuration values. | ||
| config.connectionOptions.address = 'localhost:7233'; |
Contributor
There was a problem hiding this comment.
Same here - unless we explicitly want to document this and have precedent
That being said - I still think we don't need to demonstrate this twice, I think we typically have one simpler sample than a more complex one with the override?
Comment on lines
+137
to
+167
| async function main() { | ||
| console.log('--- Loading default profile from config.toml ---'); | ||
|
|
||
| // For this sample to be self-contained, we explicitly provide the path to | ||
| // the config.toml file included in this directory. | ||
| // By default though, the config.toml file will be loaded from | ||
| // ~/.config/temporalio/temporal.toml (or the equivalent standard config directory on your OS). | ||
| const configFile = resolve(__dirname, '../config.toml'); | ||
|
|
||
| // loadClientConnectConfig is a helper that loads a profile and prepares | ||
| // the configuration for Connection.connect and Client. By default, it loads the | ||
| // "default" profile. | ||
| const config = loadClientConnectConfig({ | ||
| configSource: { path: configFile }, | ||
| }); | ||
|
|
||
| console.log(`Loaded 'default' profile from ${configFile}.`); | ||
| console.log(` Address: ${config.connectionOptions.address}`); | ||
| console.log(` Namespace: ${config.namespace}`); | ||
| console.log(` gRPC Metadata: ${JSON.stringify(config.connectionOptions.metadata)}`); | ||
|
|
||
| console.log('\nAttempting to connect to client...'); | ||
| try { | ||
| const connection = await Connection.connect(config.connectionOptions); | ||
| const client = new Client({ connection, namespace: config.namespace }); | ||
| console.log('✅ Client connected successfully!'); | ||
| await connection.close(); | ||
| } catch (err) { | ||
| console.log(`❌ Failed to connect: ${err}`); | ||
| } | ||
| } |
Contributor
There was a problem hiding this comment.
This is what I would use as a simpler sample, for my previous comment
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Notes to reviewers